refactor: give some better examples for package ID spec #13202
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR try to resolve?
The old examples are so confusing because Cargo does not use those formats. For instance: We use
https://github.com/rust-lang/crates.io-index#foo
instead ofhttps://github.com/rust-lang/crates.io-index/foo
. You can verify it by using thecargo pkgid
command.How should we test and review this PR?
It should covered by rustdoc tests.
Additional information
r? @epage
We discussed it one time during Cargo office hours.